regenerator-transform

What is regenerator-transform?

The regenerator-transform package is a plugin for Babel that allows you to transform ES2015+ generator functions into ES5 code. It is part of the Regenerator project, which aims to enable the use of generators and async functions in environments that do not natively support them. This package is typically used in the build process of JavaScript applications to ensure compatibility with older browsers or JavaScript engines.

What are regenerator-transform's main functionalities?

Generator Function Transformation

Transforms generator functions into ES5 code using the Babel plugin system. This allows developers to write modern JavaScript with generator functions and yield syntax, and then compile it down to code that can run in older JavaScript environments.

require('babel-core').transform('code', {
  plugins: ['regenerator-transform']
});

Async/Await Transformation

Enables the use of async/await syntax in JavaScript code by transforming it into generator functions and then into ES5 code. This is useful for writing asynchronous code in a more synchronous style, which can be easier to read and maintain.

require('babel-core').transform('async function foo() { await bar(); }', {
  plugins: ['regenerator-transform']
});

Other packages similar to regenerator-transform

babel-plugin-transform-async-to-generator

This package is a Babel plugin that specifically transforms async functions into generator functions. It is similar to regenerator-transform but focuses only on async/await syntax, not on general generator functions.

babel-preset-env

babel-preset-env is a Babel preset that includes regenerator-transform as one of its plugins. It allows developers to specify the target environments for their code and automatically includes the necessary plugins and polyfills to support those environments, including transformations for generators and async functions.

fast-async

fast-async is a Babel plugin that uses the nodent compiler to transform async/await syntax into Promises instead of generator functions. It provides a faster alternative to regenerator-transform for handling async functions, but does not handle generator functions.

README

regenerator-transform

Transform async/generator functions with regenerator

Installation

$ npm install regenerator-transform

Usage

Via .babelrc (Recommended)

.babelrc

// without options
{
  "plugins": ["regenerator-transform"]
}
// with options
{
  "plugins": [
    ["regenerator-transform", {
      asyncGenerators: false, // true by default
      generators: false, // true by default
      async: false // true by default
    }]
  ]
}

Via CLI

$ babel --plugins regenerator-transform script.js

Via Node API

require("@babel/core").transformSync("code", {
  plugins: ["regenerator-transform"]
});